/*
 * Copyright (c) 2010 Google Inc.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package com.google.api.data.contacts.v3.model;

import com.google.api.client.util.Key;

/**
 * Describes websites associated with the contact, including links.
 * 
 * @author Nicolas Garnier
 */
public class Website {

  /** Used to specify that the Website is an assistant. */
  public static final String TYPE_HOME_PAGE = "home-page";

  /** Used to specify that the Relation is an assistant. */
  public static final String TYPE_BLOG = "blog";

  /** Used to specify that the Relation is an assistant. */
  public static final String TYPE_PROFILE = "profile";

  /** Used to specify that the Relation is an assistant. */
  public static final String TYPE_HOME = "home";

  /** Used to specify that the Relation is an assistant. */
  public static final String TYPE_WORK = "work";

  /** Used to specify that the Relation is an assistant. */
  public static final String TYPE_OTHER = "other";

  /** Used to specify that the Relation is an assistant. */
  public static final String TYPE_FTP = "ftp";

  /**
   * A programmatic value that identifies the type of a website. Valid values
   * are {@link #TYPE_BLOG}, {@link #TYPE_FTP}, {@link #TYPE_HOME},
   * {@link #TYPE_HOME_PAGE}, {@link #TYPE_OTHER}, {@link #TYPE_PROFILE} and
   * {@link #TYPE_WORK}.
   */
  @Key("@rel")
  public String type;

  /** A simple string value used to name this website. */
  @Key("@label")
  public String label;

  /**
   * When multiple websites appear in an entry, indicates which is primary. At
   * most one website may be primary. Default value is false.
   */
  @Key("@primary")
  public Boolean primary;

  /** A link to the website. */
  @Key("@href")
  public String url;
}
